The type that defines the fields for a paginated result set. The response consists of 0 or more sequenced pages where each page has 0 or more items.
Types that use SearchPagedCollection<ItemSummary>
Not used by any types.
Calls that use SearchPagedCollection<ItemSummary>
Fields
href
The URI of the current page of results.
The following example of the search method returns items 1 thru 5 from the list of items found.
The following example of the search method returns items 1 thru 5 from the list of items found.
https://api.ebay.com/buy/v1/item_summary/search?q=shirt&limit=5&offset=0.
itemSummaries
array of ItemSummary
An array of the items on this page. The items are sorted according to the sorting method specified in the request.
limit
The value of the
limit parameter submitted in the request, which is the maximum number of items to return on a page, from the result set. A result set is the complete set of items returned by the method.next
The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.
The following example of the search method returns items 5 thru 10 from the list of items found.
The following example of the search method returns items 5 thru 10 from the list of items found.
https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=10
offset
This value indicates the
offset used for current page of items being returned. Assume the initial request used an offset of 0 and a limit of 3. Then in the first page of results, this value would be 0, and items 1-3 are returned. For the second page, this value is 3 and so on.prev
The URI for the previous page of results. This is returned if there is a previous page of results from the result set.
The following example of the search method returns items 1 thru 5 from the list of items found, which would be the first set of items returned.
The following example of the search method returns items 1 thru 5 from the list of items found, which would be the first set of items returned.
https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=0
total
The total number of items that match the input criteria.
Note:
Note:
total is just an indicator of the number of listings for a given query. It could vary based on the number of listings with variations included in the result. It is strongly recommended that total not be used in pagination use cases. Instead, use next to determine the results on the next page.